home *** CD-ROM | disk | FTP | other *** search
/ Risc World 3 / Risc World 3.iso / SOFTWARE / ISSUE4 / ZAP / !Zap / Modules / !ZapText / UK / HelpData next >
Text File  |  2002-05-08  |  10KB  |  241 lines
  1. ADDLF (ZapText - Tim Tyler)
  2. Takes a textual buffer and inserts LFs at the end of every line which would
  3. be soft-wrapped if soft-wrap was activated.  The width which is used is the
  4. current width and not the word-wrap width.  This command is designed to
  5. perform the opposite function to the command REMOVELF.  It is quite slow,
  6. but the hourglass percentage is used and it can be aborted by pressing
  7. ESCAPE.
  8.  
  9. ADDLFSEL (ZapText - Tim Tyler)
  10. Takes a selection in a textual buffer and inserts LFs at the end of every
  11. line which would be soft-wrapped if soft-wrap was activated.  See also ADDLF.
  12. This command is designed to perform the opposite function to the command
  13. REMOVELFSEL.  The action is related to that of the FORMATTEXT command.
  14. It is quite slow, but the hourglass percentage is used and it can be aborted
  15. by pressing ESCAPE.
  16.  
  17. BRACKETCURSOR (ZapText - Justin Fletcher)
  18. Brackets the word in which the cursor sits with the strings given.
  19. Parameters : <break><left string><break><right string>
  20.  
  21. BRACKETSEL (ZapText - Justin Fletcher)
  22. Brackets the selection with the strings given.
  23. Parameters : <break><left string><break><right string>
  24.  
  25. FILTERSEL <command> (ZapText - Paul Moore)
  26. This command takes the selected area of the current file, and feeds it to the
  27. standard input of the given command. The selection is replaced by the
  28. standard output. (In other words, it filter the selection through the given
  29. command.)
  30.  
  31. C-style redirection is used (ie, command <standard_in >standard_out), so only
  32. filter programs written in languages using the Shared C Library are likely to
  33. work.
  34.  
  35. Error messages are ignored.
  36. <Wimp$ScrapDir> is used for temporary files (called Zap-In and Zap-Out).
  37. The command is looked for on your run path, and then on the ZapFilters: path
  38. if it wasn't found. Some useful filters are supplied with Zap.
  39.  
  40. FILTERBUF <command> (ZapText - Paul Moore)
  41. Filters the entire buffer through the given command. See FILTERSEL.
  42.  
  43. FINDFILECURSOR (ZapText - Darren Salt)
  44. Look for an object name (file or directory) at the cursor. If successful,
  45. then attempt to load the file or open the directory (as appropriate).
  46.  
  47. FINDSEL (ZapText - Daniel Wagenaar)
  48. Search for the current selection. The parameter is one of:
  49.   "0","To[ buffer]"            : To buffer
  50.   "1","Next[ match]", "Forward"        : Forward from cursor (next match)
  51.   "-1","Previous[ match]", "Backward"    : Backward from cursor (previous match)
  52.   "2","First[ match]", "[From ]start"    : Forward from start (first match)
  53.   "-2","Last[ match]", "[From ]end"    : Backward from end (last match)
  54.  
  55. (all case insensitive).
  56.  
  57. Note that this parameter used to be numerical; it's now a string. The old,
  58. numerical, arguments are still valid, but must be passed as strings.
  59.  
  60. FORMATINDENTED (ZapText - Darren Salt)
  61. An indented version of FORMATTEXT. The text must already be indented using
  62. the supplied string; if you specify "\<" you get whatever's to the left of
  63. the cursor.
  64.  
  65. HELPCONTEXT (ZapText - Martin Ebourne)
  66. Find help for the word at the cursor, using Guttorm Vik's StrongHelp.
  67. Help paths can be configured using the c-var HelpSearchPath.
  68.  
  69. HELPSEARCH (ZapText - Martin Ebourne)
  70. Freetext search for the supplied string, using Guttorm Vik's StrongHelp.
  71. If there is no supplied string, then find help for the selected text, else
  72. prompt for a word in the minibuffer.
  73. Help paths can be configured using the c-var HelpSearchPath.
  74.  
  75. HELPSEARCHCONTEXT (ZapText - Martin Ebourne)
  76. Freetext search for the word at the cursor, using Guttorm Vik's StrongHelp.
  77. Help paths can be configured using the c-var HelpSearchPath.
  78.  
  79. HELPTOPIC (ZapText - Martin Ebourne)
  80. Find help for the supplied string, using Guttorm Vik's StrongHelp.
  81. If there is no supplied string, then find help for the selected text, else
  82. prompt for a word in the minibuffer.
  83. Help paths can be configured using the c-var HelpSearchPath.
  84.  
  85. INSERTBLANK (ZapText - Darren Salt)
  86. In text modes, inserts a space at the cursor as in !Edit.
  87. In binary modes (byte, word, code etc.), inserts the relevant number of
  88. zero bytes.
  89.  
  90. INSERTFILE (ZapText - Justin Fletcher)
  91. Insert a file at the cursor. Prefixes allow special functions :
  92.   |  The file will be indented as if typed
  93.   *  The file will be run through GSTrans first - ie you can use
  94.      system variables.
  95. Parameters : [*][|]<filename>
  96.  
  97. INSERTPIPE (ZapText - Paul Moore)
  98. Pipes the output of a command to the cursor. See FILTERSEL.
  99.  
  100. INSERTPIPEDBUF (ZapText - Paul Moore)
  101. Pipes the entire buffer through the given command to the cursor. See
  102. FILTERSEL.
  103.  
  104. INSERTPIPEDSEL (ZapText - Paul Moore)
  105. Pipes the selection through the given command to the cursor. See FILTERSEL.
  106.  
  107. LINEENDS (ZapText - Daniel Wagenaar)
  108. Replaces all occurrences of CRLF, CR, LF, LFCR by the correct return
  109. character (as set in the ‘Display-> Misc->Return char->’ submenu). This is
  110. particularly useful when you've copied a text file from an MS-DOS system,
  111. which uses CRLF instead of plain LF.
  112.  
  113. LOWERCASE (ZapText - Tim Tyler)
  114. Change next character/selected region if there is one to lower case.
  115.  
  116. LOWERCASECURSOR (ZapText - Tim Tyler)
  117. Change next character to lower case.
  118.  
  119. PIPE (ZapText - Paul Moore)
  120. Pipes the output of a command into a new buffer. See FILTERSEL.
  121.  
  122. PIPEBUF <command> (ZapText - Paul Moore)
  123. Pipes the entire buffer through the given command into a new buffer. See
  124. FILTERSEL.
  125.  
  126. PIPESEL <command> (ZapText - Paul Moore)
  127. Pipes the selection through the given command into a new buffer. See
  128. FILTERSEL.
  129.  
  130. REM (ZapText - James Aylett)
  131. A completely pointless command which does nothing. May be useful for
  132. commenting scripts or something; I don't know.
  133.  
  134. REMOVELF (ZapText - Daniel Wagenaar)
  135. Designed to convert text with fixed LFs to text with free line-endings.
  136. Converting back to fixed LFs is done by the ADDLF command.
  137. Note that the action of REMOVELF cannot be undone.
  138.  
  139. REMOVELFSEL (ZapText - Daniel Wagenaar)
  140. Acts like REMOVELF only acts on the current selection.
  141. Converting back to fixed LFs is done by the ADDLFSEL command.
  142. Note that the action of REMOVELFSEL cannot be undone.
  143.  
  144. SAVEKEEPSTAMP (ZapText - Darren Salt)
  145. Saves the file immediately (ie. no prompt), but preserving the datestamp.
  146.  
  147. SELECTUNTIL (ZapText - Tim Tyler)
  148. Selects a region under the cursor. This region is delimited by control
  149. characters or any of the characters in the supplied string. The command may
  150. be used to handle double clicks in files where the default selection routine
  151. is not appropriate. (See Zap_ReturnWord in E-ZapCalls.)
  152.  
  153. SELECTWHILE (ZapText - Tim Tyler)
  154. Selects a region under the cursor. The parameter is non-delimiters for the
  155. region. (See Zap_ReturnWord in E-ZapCalls.)
  156.  
  157. SELECTWORD (ZapText - James Aylett)
  158. Selects the word at the cursor, as defined by the current mode.
  159.  
  160. STRIPCTRLCODES (ZapText - Darren Salt)
  161. Strip control codes. In binary modes, beeps instead.
  162. Either takes a byte argument: STRIPCTRLCODES #<byte> 
  163.   Bit 0 set: strip control codes
  164.   Bit 1 set: ... except for \a, \b and \f
  165.   Bit 2 set: remove everything from soft-EOF
  166.   Bit 3 set: strip top bit set characters
  167.  
  168. or takes a string which evaluates to a numerical mask: STRIPCTRLCODES <mask>
  169. in which bit n set = remove chr code n.
  170. The default is STRIPCTRLCODES #3.
  171.  
  172. SWAPCASE (ZapText - Dominic Symes)
  173. Swap case of next character/selected region if there is one.
  174.  
  175. SWAPCASECURSOR (ZapText - James Aylett)
  176. Swap case of next character.
  177.  
  178. SWAPCRLF (ZapText - Daniel Wagenaar)
  179. Exchanges CR <-> LF (Carriage returns with linefeeds). This can be used to
  180. convert Mac style texts to RISC OS style texts, or to convert spooled output
  181. (with LFCR) to 'DOS style' text (CRLF).  This may then be converted to
  182. an ordinary RISC-OS style text by dragging it to Zap's icon bar icon.
  183. This command has been written to replace LINEENDS where possible. It is
  184. *much* faster. The action of SWAPCRLF can not be undone using the undo
  185. commands. It's action may be reversed by executing it again.
  186.  
  187. UNSPACE (ZapText - Dominic Symes)
  188. Remove excess spacing around the cursor. Note that this now works atomically
  189. (ie it can be undone in one go).
  190.  
  191. UNTABIFY (ZapText - Darren Salt)
  192. Converts tabs to spaces (the reverse of STRIPSPACES 4).
  193. In program source modes (C etc.) tabs in quotes "" are left intact.
  194.  
  195. UNTABIFYSEL (ZapText - Darren Salt)
  196. Converts tabs to spaces within the selection, provided that the selection is
  197. in the current window.
  198. In program source modes (C etc.) tabs in quotes "" are left intact.
  199.  
  200. UPPERCASE (ZapText - Tim Tyler)
  201. Change next character/selected region if there is one to upper case.
  202.  
  203. UPPERCASECURSOR (ZapText - Tim Tyler)
  204. Change next character to upper case.
  205.  
  206. @FNHELP (ZapText - James Aylett)
  207. This is a temporary command to allow StrongHelp lookup via a function call.
  208. It may be called as a function, returning NULL (the 0 pointer) if e_help
  209. fails to return anything useful, or "" (the zero-length string) otherwise.
  210. If called as a command, it will act as a call to HELPCONTEXT.
  211.  
  212. Basically the idea is that this (and FNHELPSEARCH) will disappear in the
  213. future, when it's possible for a Zap command to have an optional string
  214. argument in a future-proof way (there's a method at the moment which I'm
  215. against using in extension modules). In the future you'll be able to use
  216. HELPCONTEXT and HELPSEARCHCONTEXT as functions to do this duty.
  217.  
  218. @FNHELPSEARCH (ZapText - James Aylett)
  219. This is a temporary command to allow StrongHelp search via a function call.
  220. See FNHELP for more information.
  221.  
  222. @SELECTUNTIL (ZapText - Tim Tyler)
  223. Returns the region under the cursor. This region is delimited by control
  224. character or any of the characters in the supplied string. (See
  225. Zap_ReturnWord in E-ZapCalls.)
  226.  
  227. @SELECTWHILE (ZapText - Tim Tyler)
  228. Returns the region under the cursor. The parameter is non-delimiters for the
  229. region. (See Zap_ReturnWord in E-ZapCalls.)
  230.  
  231. @WORDOFFSTR <offset> (ZapText - James Aylett)
  232. Returns the word at (cursor+offset) as a string.
  233.  
  234. @WORDSTR (ZapText - James Aylett)
  235. Returns the word at the cursor as a string.
  236.  
  237. #HelpSearchPath (ZapText)
  238. The help search path used with StrongHelp by the HELPCONTEXT, HELPTOPIC,
  239. HELPSEARCH and HELPSEARCHCONTEXT commands and the @FNHELP and @FNHELPSEARCH
  240. functions.
  241.